Get Policy
Route
/v2/policies/{id}
Description
Retrieve a specific policy by its unique identifier. Returns detailed information about the policy configuration and enforcement rules.
Method
GET
Inputs
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The id of the policy to retrieve |
Output
| Field | Type | Description |
|---|---|---|
type | string | Always "policies" |
size | integer | Number of policies returned (always 1) |
resources | array[Policy] | Array containing the requested policy |
errors | array[Error] | Any errors encountered |
Policy Object Structure
| Field | Type | Description |
|---|---|---|
id | string | Unique policy identifier |
version | string | Version identifier for concurrency control |
type | string | Policy type (data_protection, content_inspection) |
name | string | Human-readable name |
description | string | Detailed description |
severity | string | Severity level (informational, low, medium, high, critical) |
disabled | boolean | Whether the policy is disabled |
selection_type | string | How datasets are selected (dataset, sensitivity) |
dataset_ids | array[string] | Specific dataset IDs (when selection_type is dataset) |
dataset_sensitivities | array[integer] | Sensitivity levels (when selection_type is sensitivity) |
rule | object | Rule configuration for enforcement actions |
created_at | string | Creation timestamp (ISO 8601) |
last_modified | string | Last modification timestamp (ISO 8601) |
Rate Limit
- 60 requests per minute per API key
- 5 concurrent requests per endpoint
Example Response
{
"type": "policies",
"size": 1,
"resources": [
{
"id": "policy-123",
"version": "v1.2.3",
"type": "data_protection",
"name": "Customer PII Protection",
"description": "Protect customer personal information",
"severity": "high",
"disabled": false,
"selection_type": "dataset",
"dataset_ids": ["dataset-456"],
"rule": {
"status": "risky",
"create_incident": true,
"record_screenshots": true,
"inspect_content": true,
"realtime_response_config": {
"incident_action": "warn",
"require_justification": true
}
},
"created_at": "2024-01-15T10:30:00Z",
"last_modified": "2024-01-20T14:15:00Z"
}
],
"errors": []
}